org.springframework.http.server.reactive

Class DefaultServerHttpRequestBuilder

java.lang.Object

org.springframework.http.server.reactive.DefaultServerHttpRequestBuilder

All Implemented Interfaces:

ServerHttpRequest.Builder

class DefaultServerHttpRequestBuilder
extends java.lang.Object
implements ServerHttpRequest.Builder

Package-private default implementation of ServerHttpRequest.Builder.

Since:

5.0

Author:

Rossen Stoyanchev, Sebastien Deleuze

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultServerHttpRequestBuilder.MutatedServerHttpRequest

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	body
private java.lang.String	contextPath
private MultiValueMap<java.lang.String,HttpCookie>	cookies
private HttpHeaders	httpHeaders
private java.lang.String	httpMethodValue
private ServerHttpRequest	originalRequest
private SslInfo	sslInfo
private java.net.URI	uri
private java.lang.String	uriPath

Constructor Summary

Constructors

Constructor and Description
DefaultServerHttpRequestBuilder(ServerHttpRequest original)

Method Summary

Modifier and Type	Method and Description
ServerHttpRequest	build() Build a ServerHttpRequest decorator with the mutated properties.
ServerHttpRequest.Builder	contextPath(java.lang.String contextPath) Set the contextPath to use.
private static <K,V> void	copyMultiValueMap(MultiValueMap<K,V> source, MultiValueMap<K,V> target)
private java.net.URI	getUriToUse()
ServerHttpRequest.Builder	header(java.lang.String key, java.lang.String value) Set or override the specified header.
ServerHttpRequest.Builder	headers(java.util.function.Consumer<HttpHeaders> headersConsumer) Manipulate request headers.
ServerHttpRequest.Builder	method(HttpMethod httpMethod) Set the HTTP method to return.
ServerHttpRequest.Builder	path(java.lang.String path) Set the path to use instead of the "rawPath" of the URI of the request with the following conditions: If uri is also set, the path given here overrides the path of the given URI.
ServerHttpRequest.Builder	sslInfo(SslInfo sslInfo) Set the SSL session information.
ServerHttpRequest.Builder	uri(java.net.URI uri) Set the URI to use with the following conditions: If path is also set, it overrides the path of the URI provided here.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uri

private java.net.URI uri

httpHeaders

private HttpHeaders httpHeaders

httpMethodValue

private java.lang.String httpMethodValue

cookies

private final MultiValueMap<java.lang.String,HttpCookie> cookies

uriPath

@Nullable
private java.lang.String uriPath

contextPath

@Nullable
private java.lang.String contextPath

sslInfo

@Nullable
private SslInfo sslInfo

body

private <any> body

originalRequest

private final ServerHttpRequest originalRequest

Constructor Detail

DefaultServerHttpRequestBuilder

public DefaultServerHttpRequestBuilder(ServerHttpRequest original)

Method Detail

copyMultiValueMap

private static <K,V> void copyMultiValueMap(MultiValueMap<K,V> source,
                                            MultiValueMap<K,V> target)

method

public ServerHttpRequest.Builder method(HttpMethod httpMethod)

Description copied from interface: ServerHttpRequest.Builder

Set the HTTP method to return.

Specified by:

method in interface ServerHttpRequest.Builder

uri

public ServerHttpRequest.Builder uri(java.net.URI uri)

Description copied from interface: ServerHttpRequest.Builder

Set the URI to use with the following conditions:

• If path is also set, it overrides the path of the URI provided here.
• If contextPath is also set, or already present, it must match the start of the path of the URI provided here.

Specified by:

uri in interface ServerHttpRequest.Builder

path

public ServerHttpRequest.Builder path(java.lang.String path)

Description copied from interface: ServerHttpRequest.Builder

Set the path to use instead of the "rawPath" of the URI of the request with the following conditions:

• If uri is also set, the path given here overrides the path of the given URI.
• If contextPath is also set, or already present, it must match the start of the path given here.
• The given value must begin with a slash.

Specified by:

path in interface ServerHttpRequest.Builder

contextPath

public ServerHttpRequest.Builder contextPath(java.lang.String contextPath)

Description copied from interface: ServerHttpRequest.Builder

Set the contextPath to use.

The given value must be a valid contextPath and it must match the start of the path of the URI of the request. That means changing the contextPath, implies also changing the path via ServerHttpRequest.Builder.path(String).

Specified by:

contextPath in interface ServerHttpRequest.Builder

header

public ServerHttpRequest.Builder header(java.lang.String key,
                                        java.lang.String value)

Description copied from interface: ServerHttpRequest.Builder

Set or override the specified header.

Specified by:

header in interface ServerHttpRequest.Builder

headers

public ServerHttpRequest.Builder headers(java.util.function.Consumer<HttpHeaders> headersConsumer)

Description copied from interface: ServerHttpRequest.Builder

Manipulate request headers. The provided HttpHeaders contains current request headers, so that the Consumer can overwrite or remove existing values, or use any other HttpHeaders methods.

Specified by:

headers in interface ServerHttpRequest.Builder

sslInfo

public ServerHttpRequest.Builder sslInfo(SslInfo sslInfo)

Description copied from interface: ServerHttpRequest.Builder

Set the SSL session information. This may be useful in environments where TLS termination is done at the router, but SSL information is made available in some other way such as through a header.

Specified by:

sslInfo in interface ServerHttpRequest.Builder

build

public ServerHttpRequest build()

Description copied from interface: ServerHttpRequest.Builder

Build a ServerHttpRequest decorator with the mutated properties.

Specified by:

build in interface ServerHttpRequest.Builder

getUriToUse

private java.net.URI getUriToUse()